Skip to main content

CreateRadialGradientFill

Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background.

Syntax

expression.CreateRadialGradientFill(gradientStops);

expression - A variable that represents a Api class.

Parameters

NameRequired/OptionalData typeDefaultDescription
gradientStopsRequiredArrayThe array of gradient color stops measured in 1000th of percent.

Returns

ApiFill

Example

This example shows how to create a radial gradient fill.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let gs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
let gs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
let fill = Api.CreateRadialGradientFill([gs1, gs2]);
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = Api.CreateShape("rect", 5930900, 395605, fill, stroke);
paragraph.AddDrawing(shape);